docs: update environment variable tables for utilities #1153
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Correct the default value for the POWERTOOLS_METRICS_NAMESPACE env var * Refer reader to utility page for further info on env vars
* Extract default and allowed values from description to their own cols * Add allowed values, example and default columns * Correct default value for metrics namespace
github-actions
bot
added
the
documentation
flochaz
previously approved these changes
Nov 10, 2022
Previously the Metric and Tracer classes did not set a service name if one was not provided. There was no default service name. This commit sets a default service name in the Utility class, and updates the Tracer, Metric and Logger classes to use it.
Add missing `defaultServiceName` property to expected Logger object Correct typo in test names
Remove a test that is no longer valid. As there is a default service name, the tracer should not be enabled even if there is a service name Update the `addServiceAnnotation` function to remove redundant check
The `service_name` is now set by default. This means it is always present in metric dimensions. This commit updates the tests to account for this change
Add test for getDefaultServiceName method
dreamorosi
reviewed
Nov 14, 2022
|
Last remaining task is to extract the |
This commit extracts the isValidServiceName method from the Tracer class to the Utility class.
ConnorKirk
commented
Nov 15, 2022
ConnorKirk
commented
Nov 15, 2022
ConnorKirk
commented
Nov 15, 2022
ConnorKirk
commented
Nov 15, 2022
ConnorKirk
commented
Nov 15, 2022
dreamorosi
reviewed
Nov 15, 2022
There was a problem hiding this comment.
Hi @ConnorKirk thank you for the work here, it's looking great and I think we are really close to being able to merge it.
Left just a couple of comments, I think we need 1, maybe 2, more iterations and we're done!
|
Integration tests are passing: https://github.com/awslabs/aws-lambda-powertools-typescript/actions/runs/3470528039 Since @flochaz already approved the PR earlier, I'm going to merge this. |
dreamorosi
approved these changes
Nov 15, 2022
13 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
This PR updates the environment variable documentation for the main page, and three utilities.
It also sets the default service name to
service_undefined. Previously, the Tracer and Metrics utilities did not set the service namedocs/index.mdisValidServiceNameto Utility classHow to verify this change
Related issues, RFCs
Issue number: #724
PR status
Is this ready for review?: Yes
Is it a breaking change?: No
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.